Skip to content

docs: update README #15

Merged
sbillinge merged 3 commits intodiffpy:mainfrom
ycexiao:update-readme
Apr 19, 2026
Merged

docs: update README #15
sbillinge merged 3 commits intodiffpy:mainfrom
ycexiao:update-readme

Conversation

@ycexiao
Copy link
Copy Markdown
Contributor

@ycexiao ycexiao commented Apr 18, 2026

What problem does this PR address?

Closes #13

Update README and add diffpy.apps entry point according to the README.

What should the reviewer(s) do?

@ycexiao ycexiao changed the title Update readme docs: update README Apr 18, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 18, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.94%. Comparing base (a06f7f0) to head (0a48d18).
⚠️ Report is 9 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #15      +/-   ##
==========================================
+ Coverage   92.46%   92.94%   +0.48%     
==========================================
  Files           4        4              
  Lines         146      156      +10     
==========================================
+ Hits          135      145      +10     
  Misses         11       11              
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor Author

@ycexiao ycexiao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sbillinge, it's ready for review.

Comment thread news/update-readme.rst
@@ -0,0 +1,24 @@
**Added:**

* Also add ``diffpy.apps`` as an entry point.
Copy link
Copy Markdown
Contributor Author

@ycexiao ycexiao Apr 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The package name(diffpy.apps) and the CLI app(diffpy.app) name are easy to confuse. We use diffpy.app because each time only one app is invoked.

Also add diffpy.apps as an entry point for user's convenience when they didn't notice the difference between the package name and the entry point.

@ycexiao ycexiao marked this pull request as ready for review April 18, 2026 00:31
@sbillinge sbillinge merged commit c932300 into diffpy:main Apr 19, 2026
6 checks passed
@sbillinge
Copy link
Copy Markdown
Contributor

Nice. Very kind to the users!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: update README

2 participants